home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / share / python-support / python-debian / debian_bundle / arfile.py < prev    next >
Encoding:
Python Source  |  2008-08-09  |  9.7 KB  |  315 lines
  1. # ArFile: a Python representation of ar (as in "man 1 ar") archives.
  2. # Copyright (C) 2007    Stefano Zacchiroli  <zack@debian.org>
  3. # Copyright (C) 2007    Filippo Giunchedi   <filippo@debian.org>
  4. #
  5. # This program is free software: you can redistribute it and/or modify
  6. # it under the terms of the GNU General Public License as published by
  7. # the Free Software Foundation, either version 3 of the License, or
  8. # (at your option) any later version.
  9. #
  10. # This program is distributed in the hope that it will be useful, but
  11. # WITHOUT ANY WARRANTY; without even the implied warranty of
  12. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13. # General Public License for more details.
  14. #
  15. # You should have received a copy of the GNU General Public License
  16. # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17.  
  18. GLOBAL_HEADER = "!<arch>\n"
  19. GLOBAL_HEADER_LENGTH = len(GLOBAL_HEADER)
  20.  
  21. FILE_HEADER_LENGTH = 60
  22. FILE_MAGIC = "`\n"
  23.  
  24. class ArError(Exception):
  25.     pass
  26.  
  27. class ArFile(object):
  28.     """ Representation of an ar archive, see man 1 ar.
  29.     
  30.     The interface of this class tries to mimick that of the TarFile module in
  31.     the standard library.
  32.     
  33.     ArFile objects have the following (read-only) properties:
  34.         - members       same as getmembers()
  35.     """
  36.  
  37.     def __init__(self, filename=None, mode='r', fileobj=None):
  38.         """ Build an ar file representation starting from either a filename or
  39.         an existing file object. The only supported mode is 'r' """
  40.  
  41.         self.__members = [] 
  42.         self.__members_dict = {}
  43.         self.__fname = filename
  44.         self.__fileobj = fileobj
  45.         
  46.         if mode == "r":
  47.             self.__indexArchive()
  48.         pass    # TODO write support
  49.  
  50.     def __indexArchive(self):
  51.         if self.__fname:
  52.             fp = open(self.__fname, "rb")
  53.         elif self.__fileobj:
  54.             fp = self.__fileobj
  55.         else:
  56.             raise ArError, "Unable to open valid file"
  57.  
  58.         if fp.read(GLOBAL_HEADER_LENGTH) != GLOBAL_HEADER:
  59.             raise ArError, "Unable to find global header"
  60.  
  61.         while True:
  62.             newmember = ArMember.from_file(fp, self.__fname)
  63.             if not newmember:
  64.                 break
  65.             self.__members.append(newmember)
  66.             self.__members_dict[newmember.name] = newmember
  67.             if newmember.size % 2 == 0: # even, no padding
  68.                 fp.seek(newmember.size, 1) # skip to next header
  69.             else:
  70.                 fp.seek(newmember.size + 1 , 1) # skip to next header
  71.         
  72.         if self.__fname:
  73.             fp.close()
  74.  
  75.     def getmember(self, name):
  76.         """ Return the (last occurrence of a) member in the archive whose name
  77.         is 'name'. Raise KeyError if no member matches the given name.
  78.  
  79.         Note that in case of name collisions the only way to retrieve all
  80.         members matching a given name is to use getmembers. """
  81.  
  82.         return self.__members_dict[name]
  83.  
  84.     def getmembers(self):
  85.         """ Return a list of all members contained in the archive.
  86.  
  87.         The list has the same order of members in the archive and can contain
  88.         duplicate members (i.e. members with the same name) if they are
  89.         duplicate in the archive itself. """
  90.  
  91.         return self.__members
  92.  
  93.     members = property(getmembers)
  94.  
  95.     def getnames(self):
  96.         """ Return a list of all member names in the archive. """
  97.  
  98.         return map(lambda f: f.name, self.__members)
  99.  
  100.     def extractall():
  101.         """ Not (yet) implemented. """
  102.  
  103.         raise NotImpelementedError  # TODO
  104.  
  105.     def extract(self, member, path):
  106.         """ Not (yet) implemented. """
  107.  
  108.         raise NotImpelementedError  # TODO
  109.  
  110.     def extractfile(self, member):
  111.         """ Return a file object corresponding to the requested member. A member
  112.         can be specified either as a string (its name) or as a ArMember
  113.         instance. """
  114.  
  115.         for m in self.__members:
  116.             if isinstance(member, ArMember) and m.name == member.name:
  117.                 return m
  118.             elif member == m.name:
  119.                 return m
  120.             else:
  121.                 return None 
  122.  
  123.     # container emulation
  124.  
  125.     def __iter__(self):
  126.         """ Iterate over the members of the present ar archive. """
  127.  
  128.         return iter(self.__members)
  129.  
  130.     def __getitem__(self, name):
  131.         """ Same as .getmember(name). """
  132.  
  133.         return self.getmember(name)
  134.  
  135.  
  136. class ArMember(object):
  137.     """ Member of an ar archive.
  138.  
  139.     Implements most of a file object interface: read, readline, next,
  140.     readlines, seek, tell, close.
  141.     
  142.     ArMember objects have the following (read-only) properties:
  143.         - name      member name in an ar archive
  144.         - mtime     modification time
  145.         - owner     owner user
  146.         - group     owner group
  147.         - fmode     file permissions
  148.         - size      size in bytes
  149.         - fname     file name"""
  150.  
  151.     def __init__(self):
  152.         self.__name = None      # member name (i.e. filename) in the archive
  153.         self.__mtime = None     # last modification time
  154.         self.__owner = None     # owner user
  155.         self.__group = None     # owner group
  156.         self.__fmode = None     # permissions
  157.         self.__size = None      # member size in bytes
  158.         self.__fname = None     # file name associated with this member
  159.         self.__fp = None        # file pointer 
  160.         self.__offset = None    # start-of-data offset
  161.         self.__end = None       # end-of-data offset
  162.  
  163.     def from_file(fp, fname):
  164.         """fp is an open File object positioned on a valid file header inside
  165.         an ar archive. Return a new ArMember on success, None otherwise. """
  166.  
  167.         buf = fp.read(FILE_HEADER_LENGTH)
  168.  
  169.         if not buf:
  170.             return None
  171.  
  172.         # sanity checks
  173.         if len(buf) < FILE_HEADER_LENGTH:
  174.             raise IOError, "Incorrect header length"
  175.  
  176.         if buf[58:60] != FILE_MAGIC:
  177.             raise IOError, "Incorrect file magic"
  178.  
  179.         # http://en.wikipedia.org/wiki/Ar_(Unix)    
  180.         #from   to     Name                      Format
  181.         #0      15     File name                 ASCII
  182.         #16     27     File modification date    Decimal
  183.         #28     33     Owner ID                  Decimal
  184.         #34     39     Group ID                  Decimal
  185.         #40     47     File mode                 Octal
  186.         #48     57     File size in bytes        Decimal
  187.         #58     59     File magic                \140\012
  188.  
  189.         # XXX struct.unpack can be used as well here
  190.         f = ArMember()
  191.         f.__name = buf[0:16].split("/")[0].strip()
  192.         f.__mtime = int(buf[16:28])
  193.         f.__owner = int(buf[28:34])
  194.         f.__group = int(buf[34:40])
  195.         f.__fmode  = buf[40:48]  # XXX octal value
  196.         f.__size  = int(buf[48:58])
  197.  
  198.         f.__fname = fname
  199.         f.__offset = fp.tell() # start-of-data
  200.         f.__end = f.__offset + f.__size
  201.  
  202.         return f
  203.  
  204.     from_file = staticmethod(from_file)
  205.     
  206.     # file interface
  207.  
  208.     # XXX this is not a sequence like file objects
  209.     def read(self, size=0):
  210.         if self.__fp is None:
  211.             self.__fp = open(self.__fname, "r")
  212.             self.__fp.seek(self.__offset)
  213.  
  214.         cur = self.__fp.tell()
  215.  
  216.         if size > 0 and size <= self.__end - cur: # there's room
  217.             return self.__fp.read(size)
  218.  
  219.         if cur >= self.__end or cur < self.__offset:
  220.             return ''
  221.  
  222.         return self.__fp.read(self.__end - cur)
  223.  
  224.     def readline(self, size=None):
  225.         if self.__fp is None:
  226.             self.__fp = open(self.__fname, "r")
  227.             self.__fp.seek(self.__offset)
  228.  
  229.         if size is not None: 
  230.             buf = self.__fp.readline(size)
  231.             if self.__fp.tell() > self.__end:
  232.                 return ''
  233.  
  234.             return buf
  235.  
  236.         buf = self.__fp.readline()
  237.         if self.__fp.tell() > self.__end:
  238.             return ''
  239.         else:
  240.             return buf
  241.  
  242.     def readlines(self, sizehint=0):
  243.         if self.__fp is None:
  244.             self.__fp = open(self.__fname, "r")
  245.             self.__fp.seek(self.__offset)
  246.         
  247.         buf = None
  248.         lines = []
  249.         while True: 
  250.             buf = self.readline()
  251.             if not buf: 
  252.                 break
  253.             lines.append(buf)
  254.  
  255.         return lines
  256.  
  257.     def seek(self, offset, whence=0):
  258.         if self.__fp is None:
  259.             self.__fp = open(self.__fname, "r")
  260.             self.__fp.seek(self.__offset)
  261.  
  262.         if self.__fp.tell() < self.__offset:
  263.             self.__fp.seek(self.__offset)
  264.  
  265.         if whence < 2 and offset + self.__fp.tell() < self.__offset:
  266.             raise IOError, "Can't seek at %d" % offset
  267.         
  268.         if whence == 1:
  269.             self.__fp.seek(offset, 1)
  270.         elif whence == 0:
  271.             self.__fp.seek(self.__offset + offset, 0)
  272.         elif whence == 2:
  273.             self.__fp.seek(self.__end + offset, 0)
  274.  
  275.     def tell(self):
  276.         if self.__fp is None:
  277.             self.__fp = open(self.__fname, "r")
  278.             self.__fp.seek(self.__offset)
  279.  
  280.         cur = self.__fp.tell()
  281.         
  282.         if cur < self.__offset:
  283.             return 0L
  284.         else:
  285.             return cur - self.__offset
  286.  
  287.     def close(self):
  288.         if self.__fp is not None:
  289.             self.__fp.close()
  290.    
  291.     def next(self):
  292.         return self.readline()
  293.     
  294.     def __iter__(self):
  295.         def nextline():
  296.             line = self.readline()
  297.             if line:
  298.                 yield line
  299.  
  300.         return iter(nextline())
  301.  
  302.     name = property(lambda self: self.__name)
  303.     mtime = property(lambda self: self.__mtime)
  304.     owner = property(lambda self: self.__owner)
  305.     group = property(lambda self: self.__group)
  306.     fmode = property(lambda self: self.__fmode)
  307.     size = property(lambda self: self.__size)
  308.     fname = property(lambda self: self.__fname)
  309.  
  310. if __name__ == '__main__':
  311.     # test
  312.     # ar r test.ar <file1> <file2> .. <fileN>
  313.     a = ArFile("test.ar")
  314.     print "\n".join(a.getnames())
  315.